home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / smaltalk / manchest.lha / MANCHESTER / usenet / st80_pre4 / pretty-print / README < prev    next >
INI File  |  1993-07-24  |  3KB  |  82 lines

  1. [Instructions seem to be in the comments in smalltalkToTexMacro.doc]
  2.  
  3. From: rebecca@small (Rebecca Y. Shen)
  4. Newsgroups: comp.lang.smalltalk
  5. Subject: Pretty-printing Smalltalk via TeX
  6. Keywords: printing, TeX,  Smalltalk
  7. Message-ID: <1991Oct6.014503.4042@cco.caltech.edu>
  8. Date: Sun, 6 Oct 91 02:45:03 BST
  9. Organization: California Institute of Technology, Pasadena
  10.  
  11. A while ago someone asked about producing nicely formatted Smalltalk
  12. code (specifically it was having footers with the class name), and
  13. hopefully I will now overkill that request for those of you that
  14. have TeX available to you. 
  15.  
  16. SmalltalkToTex is a TeX macro that can read a Smalltalk chunk file
  17. and format it with TeX.
  18.  
  19. Fairly common stuff:
  20.   1) formats all the special characters (^,_,:=,etc.), 
  21.   2) wraps and indents long lines  
  22.   3) formats comments and message selectors
  23.   4) breaks pages between classes 
  24.  
  25. Uncommon stuff:
  26.   1) produces headers and footers with:
  27.         class name, section name
  28.         page number (within the class)
  29.         print time
  30.  
  31.       and by adding comments to your Smalltalk file (which
  32.       Smalltalk could automatically generate) the head/foot
  33.       could include:
  34.         class hierarchy, category, version, and whatever 
  35.         else you consider important. 
  36.  
  37.   2) can print in 2-column mode, 
  38.   3) inhibits methods from splitting between pages,
  39.   4) line-numbers (ich, but can be useful)
  40.  
  41. Really uncommon stuff:
  42.    1) works with LaTeX and Texinfo, and can:
  43.        * add table of contents entries for classes, class sections, 
  44.          and subsections (eg: method categories) 
  45.        * add index entries for message selectors
  46.    2) can include diagrams (again by adding comments to your Smalltalk
  47.       file).
  48.    3) There are no intermediary files; the macro can read a chunk 
  49.       format file directly. 
  50.  
  51.  
  52. Since the macros can't really read Smalltalk, they do not format
  53. the method code itself; they don't format messages differently from 
  54. variables, or format local, instance, and pool variables differently 
  55. from each other. 
  56.  
  57. There is a lot of flexibility in the output courtesy of TeX: you 
  58. have access to many fonts, the information from the Smalltalk file
  59. can be processed quite a bit, special characters used in the output,
  60. and so on. 
  61.  
  62. The macros work in TeX but don't require much (if any) knowledge of TeX. 
  63. If you like one of the demo formats you don't ever need to touch TeX code.
  64. If you don't have TeX and would like to, there are inexpensive and 
  65. free versions of it available, as well as expensive versions if you
  66. would prefer. 
  67.  
  68. I tried to include reasonable documentation, a good set of examples, 
  69. and to test the macros on many types of files, and I hope 
  70. smalltalkToTex will be useful to most of you; if it is not,
  71. please tell me why. The program is a version of shareware (dinnerware). 
  72.  
  73. Send me any comments and bug reports via:
  74.      rebecca@tybalt.caltech.edu   
  75. who will get them to me. 
  76.  
  77.  
  78.  
  79.                                         -- Mark L. Fussell
  80.  
  81.  
  82.